org.springframework.test.web.servlet.setup

Class StandaloneMockMvcBuilder

java.lang.Object

org.springframework.test.web.servlet.MockMvcBuilderSupport

org.springframework.test.web.servlet.setup.AbstractMockMvcBuilder<StandaloneMockMvcBuilder>

org.springframework.test.web.servlet.setup.StandaloneMockMvcBuilder

All Implemented Interfaces:

MockMvcBuilder, ConfigurableMockMvcBuilder<StandaloneMockMvcBuilder>

public class StandaloneMockMvcBuilder
extends AbstractMockMvcBuilder<StandaloneMockMvcBuilder>

A MockMvcBuilder that accepts @Controller registrations thus allowing full control over the instantiation and initialization of controllers and their dependencies similar to plain unit tests, and also making it possible to test one controller at a time.

This builder creates the minimum infrastructure required by the DispatcherServlet to serve requests with annotated controllers and also provides methods for customization. The resulting configuration and customization options are equivalent to using MVC Java config except using builder style methods.

To configure view resolution, either select a "fixed" view to use for every request performed (see setSingleView(View)) or provide a list of ViewResolvers (see setViewResolvers(ViewResolver...)).

Since:

3.2

Author:

Rossen Stoyanchev

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	StandaloneMockMvcBuilder.StandaloneConfiguration Using the MVC Java configuration as the starting point for the "standalone" setup
private static class	StandaloneMockMvcBuilder.StaticRequestMappingHandlerMapping A RequestMappingHandlerMapping that allows registration of controllers.
private static class	StandaloneMockMvcBuilder.StaticStringValueResolver A static resolver placeholder for values embedded in request mappings.
private static class	StandaloneMockMvcBuilder.StaticViewResolver A ViewResolver that always returns same View.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.Long	asyncRequestTimeout
private ContentNegotiationManager	contentNegotiationManager
private java.lang.Object[]	controllers
private FormattingConversionService	conversionService
private java.util.List<HandlerMethodArgumentResolver>	customArgumentResolvers
private java.util.List<HandlerMethodReturnValueHandler>	customReturnValueHandlers
private FlashMapManager	flashMapManager
private java.util.List<HandlerExceptionResolver>	handlerExceptionResolvers
private LocaleResolver	localeResolver
private java.util.List<MappedInterceptor>	mappedInterceptors
private java.util.List<HttpMessageConverter<?>>	messageConverters
private java.util.Map<java.lang.String,java.lang.String>	placeHolderValues
private java.lang.Boolean	removeSemicolonContent
private boolean	useSuffixPatternMatch
private boolean	useTrailingSlashPatternMatch
private Validator	validator
private java.util.List<ViewResolver>	viewResolvers

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StandaloneMockMvcBuilder(java.lang.Object... controllers) Protected constructor.

Method Summary

Modifier and Type	Method and Description
StandaloneMockMvcBuilder	addInterceptors(HandlerInterceptor... interceptors) Add interceptors mapped to all incoming requests.
StandaloneMockMvcBuilder	addMappedInterceptors(java.lang.String[] pathPatterns, HandlerInterceptor... interceptors) Add interceptors mapped to a set of path patterns.
StandaloneMockMvcBuilder	addPlaceHolderValue(java.lang.String name, java.lang.String value) In a standalone setup there is no support for placeholder values embedded in request mappings.
private java.util.List<ViewResolver>	initViewResolvers(WebApplicationContext wac)
protected WebApplicationContext	initWebAppContext() A method to obtain the WebApplicationContext to be passed to the DispatcherServlet.
private void	registerMvcSingletons(StubWebApplicationContext wac)
StandaloneMockMvcBuilder	setAsyncRequestTimeout(long timeout) Specify the timeout value for async execution.
protected StandaloneMockMvcBuilder	setContentNegotiationManager(ContentNegotiationManager contentNegotiationManager) Set a ContentNegotiationManager.
StandaloneMockMvcBuilder	setConversionService(FormattingConversionService conversionService) Provide a conversion service with custom formatters and converters.
StandaloneMockMvcBuilder	setCustomArgumentResolvers(HandlerMethodArgumentResolver... argumentResolvers) Provide custom resolvers for controller method arguments.
StandaloneMockMvcBuilder	setCustomReturnValueHandlers(HandlerMethodReturnValueHandler... handlers) Provide custom handlers for controller method return values.
StandaloneMockMvcBuilder	setFlashMapManager(FlashMapManager flashMapManager) Provide a custom FlashMapManager instance.
StandaloneMockMvcBuilder	setHandlerExceptionResolvers(HandlerExceptionResolver... exceptionResolvers) Set the HandlerExceptionResolver types to use as an array.
StandaloneMockMvcBuilder	setHandlerExceptionResolvers(java.util.List<HandlerExceptionResolver> exceptionResolvers) Set the HandlerExceptionResolver types to use as a list.
StandaloneMockMvcBuilder	setLocaleResolver(LocaleResolver localeResolver) Provide a LocaleResolver instance.
StandaloneMockMvcBuilder	setMessageConverters(HttpMessageConverter<?>... messageConverters) Set the message converters to use in argument resolvers and in return value handlers, which support reading and/or writing to the body of the request and response.
StandaloneMockMvcBuilder	setRemoveSemicolonContent(boolean removeSemicolonContent) Set if ";" (semicolon) content should be stripped from the request URI.
StandaloneMockMvcBuilder	setSingleView(View view) Sets up a single ViewResolver that always returns the provided view instance.
StandaloneMockMvcBuilder	setUseSuffixPatternMatch(boolean useSuffixPatternMatch) Whether to use suffix pattern match (".*") when matching patterns to requests.
StandaloneMockMvcBuilder	setUseTrailingSlashPatternMatch(boolean useTrailingSlashPatternMatch) Whether to match to URLs irrespective of the presence of a trailing slash.
StandaloneMockMvcBuilder	setValidator(Validator validator) Provide a custom Validator instead of the one created by default.
StandaloneMockMvcBuilder	setViewResolvers(ViewResolver... resolvers) Set up view resolution with the given ViewResolvers.

Methods inherited from class org.springframework.test.web.servlet.setup.AbstractMockMvcBuilder

addFilter, addFilters, alwaysDo, alwaysExpect, apply, build, defaultRequest, dispatchOptions

Methods inherited from class org.springframework.test.web.servlet.MockMvcBuilderSupport

createMockMvc

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

controllers

private final java.lang.Object[] controllers

messageConverters

private java.util.List<HttpMessageConverter<?>> messageConverters

customArgumentResolvers

private java.util.List<HandlerMethodArgumentResolver> customArgumentResolvers

customReturnValueHandlers

private java.util.List<HandlerMethodReturnValueHandler> customReturnValueHandlers

mappedInterceptors

private final java.util.List<MappedInterceptor> mappedInterceptors

validator

private Validator validator

contentNegotiationManager

private ContentNegotiationManager contentNegotiationManager

conversionService

private FormattingConversionService conversionService

handlerExceptionResolvers

private java.util.List<HandlerExceptionResolver> handlerExceptionResolvers

asyncRequestTimeout

private java.lang.Long asyncRequestTimeout

viewResolvers

private java.util.List<ViewResolver> viewResolvers

localeResolver

private LocaleResolver localeResolver

flashMapManager

private FlashMapManager flashMapManager

useSuffixPatternMatch

private boolean useSuffixPatternMatch

useTrailingSlashPatternMatch

private boolean useTrailingSlashPatternMatch

removeSemicolonContent

private java.lang.Boolean removeSemicolonContent

placeHolderValues

private java.util.Map<java.lang.String,java.lang.String> placeHolderValues

Constructor Detail

StandaloneMockMvcBuilder

protected StandaloneMockMvcBuilder(java.lang.Object... controllers)

Protected constructor. Not intended for direct instantiation.

See Also:

MockMvcBuilders.standaloneSetup(Object...)

Method Detail

setMessageConverters

public StandaloneMockMvcBuilder setMessageConverters(HttpMessageConverter<?>... messageConverters)

Set the message converters to use in argument resolvers and in return value handlers, which support reading and/or writing to the body of the request and response. If no message converters are added to the list, a default list of converters is added instead.

setValidator

public StandaloneMockMvcBuilder setValidator(Validator validator)

Provide a custom Validator instead of the one created by default. The default implementation used, assuming JSR-303 is on the classpath, is LocalValidatorFactoryBean.

setConversionService

public StandaloneMockMvcBuilder setConversionService(FormattingConversionService conversionService)

Provide a conversion service with custom formatters and converters. If not set, a DefaultFormattingConversionService is used by default.

addInterceptors

public StandaloneMockMvcBuilder addInterceptors(HandlerInterceptor... interceptors)

Add interceptors mapped to all incoming requests.

addMappedInterceptors

public StandaloneMockMvcBuilder addMappedInterceptors(java.lang.String[] pathPatterns,
                                                      HandlerInterceptor... interceptors)

Add interceptors mapped to a set of path patterns.

setContentNegotiationManager

protected StandaloneMockMvcBuilder setContentNegotiationManager(ContentNegotiationManager contentNegotiationManager)

Set a ContentNegotiationManager.

setAsyncRequestTimeout

public StandaloneMockMvcBuilder setAsyncRequestTimeout(long timeout)

Specify the timeout value for async execution. In Spring MVC Test, this value is used to determine how to long to wait for async execution to complete so that a test can verify the results synchronously.

Parameters:

timeout - the timeout value in milliseconds

setCustomArgumentResolvers

public StandaloneMockMvcBuilder setCustomArgumentResolvers(HandlerMethodArgumentResolver... argumentResolvers)

Provide custom resolvers for controller method arguments.

setCustomReturnValueHandlers

public StandaloneMockMvcBuilder setCustomReturnValueHandlers(HandlerMethodReturnValueHandler... handlers)

Provide custom handlers for controller method return values.

setHandlerExceptionResolvers

public StandaloneMockMvcBuilder setHandlerExceptionResolvers(java.util.List<HandlerExceptionResolver> exceptionResolvers)

Set the HandlerExceptionResolver types to use as a list.

setHandlerExceptionResolvers

public StandaloneMockMvcBuilder setHandlerExceptionResolvers(HandlerExceptionResolver... exceptionResolvers)

Set the HandlerExceptionResolver types to use as an array.

setViewResolvers

public StandaloneMockMvcBuilder setViewResolvers(ViewResolver... resolvers)

Set up view resolution with the given ViewResolvers. If not set, an InternalResourceViewResolver is used by default.

setSingleView

public StandaloneMockMvcBuilder setSingleView(View view)

Sets up a single ViewResolver that always returns the provided view instance. This is a convenient shortcut if you need to use one View instance only -- e.g. rendering generated content (JSON, XML, Atom).

setLocaleResolver

public StandaloneMockMvcBuilder setLocaleResolver(LocaleResolver localeResolver)

Provide a LocaleResolver instance. If not provided, the default one used is AcceptHeaderLocaleResolver.

setFlashMapManager

public StandaloneMockMvcBuilder setFlashMapManager(FlashMapManager flashMapManager)

Provide a custom FlashMapManager instance. If not provided, SessionFlashMapManager is used by default.

setUseSuffixPatternMatch

public StandaloneMockMvcBuilder setUseSuffixPatternMatch(boolean useSuffixPatternMatch)

Whether to use suffix pattern match (".*") when matching patterns to requests. If enabled a method mapped to "/users" also matches to "/users.*".

The default value is true.

setUseTrailingSlashPatternMatch

public StandaloneMockMvcBuilder setUseTrailingSlashPatternMatch(boolean useTrailingSlashPatternMatch)

Whether to match to URLs irrespective of the presence of a trailing slash. If enabled a method mapped to "/users" also matches to "/users/".

The default value is true.

setRemoveSemicolonContent

public StandaloneMockMvcBuilder setRemoveSemicolonContent(boolean removeSemicolonContent)

Set if ";" (semicolon) content should be stripped from the request URI. The value, if provided, is in turn set on AbstractHandlerMapping.setRemoveSemicolonContent(boolean).

addPlaceHolderValue

public StandaloneMockMvcBuilder addPlaceHolderValue(java.lang.String name,
                                                    java.lang.String value)

In a standalone setup there is no support for placeholder values embedded in request mappings. This method allows manually provided placeholder values so they can be resolved. Alternatively consider creating a test that initializes a WebApplicationContext.

initWebAppContext

protected WebApplicationContext initWebAppContext()

Description copied from class: AbstractMockMvcBuilder

A method to obtain the WebApplicationContext to be passed to the DispatcherServlet. Invoked from AbstractMockMvcBuilder.build() before the MockMvc instance is created.

Specified by:

initWebAppContext in class AbstractMockMvcBuilder<StandaloneMockMvcBuilder>

registerMvcSingletons

private void registerMvcSingletons(StubWebApplicationContext wac)

initViewResolvers

private java.util.List<ViewResolver> initViewResolvers(WebApplicationContext wac)